home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / swop145k.zip / SWOP.DOC < prev    next >
Text File  |  1992-09-19  |  19KB  |  393 lines
  1.  
  2.                          ╔════╗
  3.                          ║    ╩
  4.                          ║
  5.                          ╚════╗  ╦     ╦ ╔════╗ ╔════╗
  6.                               ║  ║  ╦  ║ ║    ║ ║    ║
  7.                          ╦    ║  ║  ║  ║ ║    ║ ║    ║
  8.                          ╚════╝  ╚══╩══╝ ╚════╝ ╠════╝
  9.                                                 ║
  10.                                                 ║
  11.                                                 ╩
  12.  
  13.  
  14.                               CopyRighted 1991 by
  15.  
  16.                            PC-2-PC COMMUNICATIONS CC
  17.  
  18.  
  19.  
  20. ══════════════════════════════════════════════════════════════════════════════
  21.  
  22.                  A door for a PCBoard Version 14.5 BBS software.
  23.  
  24.           This door allows a SYSOP to provide his users with a facility
  25.                 to SWOP their time available for more bytes,  or,
  26.                    to swop their bytes available for more time.
  27.  
  28. ══════════════════════════════════════════════════════════════════════════════
  29.  
  30.               PC-2-PC COMMUNICATIONS is situated in South Africa.
  31.  
  32.               BBS tel. no's :  Node 1 - (011) 391-3627  (2400 bps)
  33.                                Node 2 - (011) 391-3628  (2400 bps)
  34.  
  35.  
  36.  
  37. ╔═══════╗
  38. ║ INDEX ║
  39. ╚═══════╝
  40.  
  41.  
  42.              Opening words............................... 1
  43.              System requirements......................... 1
  44.              Installation................................ 2
  45.              Syntax and parameters for SWOP.EXE.......... 4
  46.              Features.................................... 5
  47.              A special word about Base Baud Rate......... 6
  48.              What if you do not registered as a user..... 6
  49.              List of files with descriptions............. 6
  50.              History of the program releases............. 7
  51.  
  52.  
  53. ╔═══════════════╗                                                PAGE 1
  54. ║ OPENING WORDS ║
  55. ╚═══════════════╝
  56.  
  57.     This software,  along with its documentation is CopyRight by
  58.     PC-2-PC COMMUNICATION CC.  You may not alter anything inside the
  59.     program,  and/or the documentation.
  60.  
  61.     This software is being distributed under the Public Domain concept.
  62.     This means that you as the user are allowed to use the program for
  63.     as long as you like.   We do not require any registration's at
  64.     all.  The software is not crippled in any way.  Should you wish to
  65.     have the latest copy of this door,  you may call our BBS in RSA at
  66.     (011) 391-3627.  It is in the SYSOP's conference on the BBS.
  67.  
  68.     We have located other versions of SWOP,  which was tampered to by
  69.     other's.  We have no idea who the guilty party was,  but if you
  70.     want to ensure that you get a tamper-free version,  we recommend
  71.     you get a copy of this door directly from us in South Africa.
  72.  
  73.     For you American guys.  You my contact Salt-Air anytime for a copy,
  74.     as that is the first place we send a copy of swop to.  Chances that
  75.     a copy on their system is tampered on,  are very small.
  76.  
  77.  
  78.  
  79. ╔═════════════════════╗
  80. ║ SYSTEM REQUIREMENTS ║
  81. ╚═════════════════════╝
  82.     Hardware  :  IBM Compatible,  modem,  hard-drive,  ect.
  83.     Software  :  PCBoard Version 14.5a BBS software
  84.     Memory    :  The available RAM required to run this door is 110 kB.
  85.  
  86.     Networks  :  On a network,  ensure that file-server has some
  87.                  sub-directory,  accessible to all nodes.  This is
  88.                  where the security-access "SWOPPWRD" file would
  89.                  be referenced to as a parameter.
  90.  
  91.     Other     :  A VERY HARD WORKING SYSOP!!!!!
  92.  
  93. ╔══════════════╗                                                 PAGE 2
  94. ║ INSTALLATION ║
  95. ╚══════════════╝
  96.  
  97.     This section is placed so early in the documentation so that you
  98.     do not have to read about an half an hour,  before you find the
  99.     installation part.
  100.  
  101.     First we have to mention the following:
  102.       If you really hate reading documents,  you could always just
  103.       run the program direct from the DOS prompt,  and it would lead
  104.       you to install it correctly.
  105.  
  106.     Now,  here is a proper description of how to install this door.
  107.     No fancy stuff required with the SWOP door.
  108.  
  109.       Just follow the following steps one by one:
  110.  
  111.     1.   Ensure that you have somewhere in your Path statement located
  112.          usually in the AUTOEXEC.BAT file, a path stating the location
  113.          of your PCBOARD sub-directory,   or just simply make sure you
  114.          do change the directory in the file SWOP(created by yourself)
  115.          to the PCBOARD sub-directory,  before calling SWOP.EXE.
  116.  
  117.     2.   Now go to your PCBoard sub-directory,  and run PCBSETUP.
  118.  
  119.     3.   Select either      J  Main Board Configuration
  120.                                         or
  121.                             K  Conferences.
  122.  
  123.          Conferences in the case if you plan to install SWOP door
  124.          inside a specific conference only.
  125.  
  126.     4.   Select now under Doors: "Path/Name List File" and select
  127.          your DOORS.LST file with 'F2'.
  128.  
  129.     5.   Go to the last entry and enter 'Alt-I' to add this door,
  130.          and enter stuff as follow:
  131.  
  132.   Filename  Password Sec Login USER.SYS DOOR.SYS Shell Path to Batch Files
  133.  ══════════ ════════ ═══ ═════ ════════ ════════ ═════ ════════════════════
  134. 1) SWOP               0    N       Y        N      Y     <path for SWOP>
  135.  
  136.          Save it now.  (Take note of Y under USERS.SYS)
  137.          The Y under Shell may be N or S,  only affect the PCB opperation.
  138.  
  139.     6.   Select now under Doors: "Menu Listing" your DOORS menu file
  140.          and add the SWOP door listing in your menu.
  141.                                                                 PAGE 3
  142.     7.   Now create the SWOP file at the location you specified in
  143.          step (5) five.    Not SWOP.BAT,  as PCBoard expects you to
  144.          have the batch file commands in a file for himself,  without
  145.          the "BAT" extension.
  146.          PCBoard will create its own DOOR.BAT file,  to eliminate
  147.          a possibility of share violations if you had a Network
  148.          installed.
  149.  
  150.          Inside the SWOP file enter the following commands
  151.  
  152.             ECHO OFF
  153.             CD <location of SWOP.EXE ex: C:\PCB\DOORS>
  154.             SWOP <location of "SWOPPWRD"  ex: Z:\DOORS\SWOPPWRD>
  155.             CD <back to PCBoard sub-directory>
  156.             EXIT <if you shelled else BOARD if you did not shell>
  157.  
  158.  
  159.     That's it folks,  the minimum requirements is above to get your door
  160.     up and running.
  161.  
  162.     Here is what our SWOP file looks like on our BBS:
  163.              @ECHO OFF
  164.              C:\PCB\DOORS\SWOP\SWOP C:\PCB\DOORS\SWOP\SWOPPWRD
  165.              EXIT         <== Make "BOARD" if Shell is set to "N".
  166.  
  167. ╔════════════════════════════════════╗                           PAGE 4
  168. ║ SYNTAX AND PARAMETERS FOR SWOP.EXE ║
  169. ╚════════════════════════════════════╝
  170.  
  171. Syntax:  SWOP <full path for SWOPPWRD> <\S> <\T or \B>
  172.  
  173.  <Full path for SWOPPWRD> : This means that we want you to specify the
  174.                             exact path and name of the SWOPPWRD file.
  175.                                (SWOPPWRD gets created by the door)
  176.                             This is very important if operating in
  177.                             a networking or multi-tasking environment.
  178.  
  179.  <\S> : If \S is specified,  the door returns with an message
  180.         "Returning back to BBS.....".
  181.          If \S is NOT specified,  no message is given on return.
  182.  
  183.  <\T> : This tells the system to disable swop of time for more bytes.
  184.         It means that users can swop bytes for more time,  but not time
  185.         for more bytes.
  186.  
  187.  <\B> : This tells the system to disable swop of bytes for more time.
  188.         It means that users can swop time for more bytes,  but not bytes
  189.         for more time.
  190.  
  191.               Ex : SWOP C:\PCB\DOORS\SWOP\SWOPPWRD \S \T
  192.  
  193.  Any or all parameters may be left out,  no "must" for any parameter.
  194.  
  195.                      Parameters is not case sensitive.
  196.  
  197.       REMEMBER: Set the USER.SYS flag inside DOOR.LST to yes!!!!!
  198.  
  199.  
  200. ╔══════════╗                                                     PAGE 5
  201. ║ FEATURES ║
  202. ╚══════════╝
  203.  
  204.     1.   Support from Com1 up to Com4.
  205.     2.   Support from 300 baud up to 115,000 Baud.
  206.     3.   ANSI Emulation,  without the need of ANSI.SYS in CONFIG.SYS
  207.     4.   Auto detection of the com port in use,  and baud rate.
  208.     5.   Detection of Data Carrier Detect.  The door will recycle back
  209.          to PCBoard,  in the case of a Carrier Lost,  while in the door.
  210.     6.   Auto adapt to the bell flag the SYSOP has setted, to
  211.          ensure that if the flag was set to off,  the door do not
  212.          send bell sounds to the local speaker.
  213.     7.   Auto detection of keyboard time-out period as setted inside
  214.          PCBoard.  Your user will be exited back to PCBoard if he
  215.          does not press a key within your specified time limit.
  216.     8.   Filtering of characters.  This ensures that most line noise
  217.          usually over the line is filtered out.
  218.     9.   Multiple commands accepted if entered at command line,  just
  219.          the same as with PCBoard.
  220.    10.   Allow the user to change between Graphics and normal mode.
  221.    11.   Give help information to users that need it.
  222.    12.   Correct updating of callers log,  to see what the user did
  223.          while he was inside the SWOP door.
  224.    13.   Allow the user to re-display the screen,  if the screen was
  225.          garbled.
  226.    14.   Will not allow a user with unlimited bytes facility to trade
  227.          bytes or time.  A user with unlimited bytes would otherwise
  228.          have been able to have unlimited time as well.
  229.    15.   Will not give access to a user,  if the SYSOP has setted the
  230.          bytes/minute to 0 bytes.  An way to stop certain users to use
  231.          the facility if the SYSOP wishes to do so.
  232.    16.   Allow the user to trade time in for more bytes to download.
  233.    17.   Allow the user to trade bytes in for more time on the system.
  234.    18.   Allow the SYSOP to set a bytes/minute,  min time left,  and
  235.          a base baud rate for every security level individually.
  236.          All this from the local console only,  without the need to drop
  237.          to DOS,  to run a special editor
  238.    19.   Ability to let the bytes/minute change according to the users
  239.          connect speed.
  240.          (Bytes/Minute = Bytes/minute * Base Baud rate / Connect speed.)
  241.  
  242. ╔═════════════════════════════════════╗                           PAGE 6
  243. ║ A SPECIAL WORD ABOUT BASE BAUD RATE ║
  244. ╚═════════════════════════════════════╝
  245.   The base baud rate give you the facility to let the bytes per minute
  246.   change according to the connect speed of your user.  (This is one of
  247.   the configuration facilities as in item 18 on previous page)
  248.  
  249. { Bytes per minute = Bytes per minute * (Base Baud Rate / connect speed) }
  250.  
  251.    Assume the following setting were inside the SWOPPWRD file.
  252.        Bytes per minute = 10000,       Base Baud Rate = 2400
  253.  
  254.  
  255.  Connect speed |           Calculation of new Bytes per minute
  256.  ==============|===========================================================
  257.     300 baud   | Bytes per min = 10000 * (2400 / 300)    =    80000
  258.    1200 baud   | Bytes per min = 10000 * (2400 / 1200)   =    20000
  259.    2400 baud   | Bytes per min = 10000 * (2400 / 2400)   =    10000
  260.    9600 baud   | Bytes per min = 10000 * (2400 / 9600)   =     2500
  261.   19200 baud   | Bytes per min = 10000 * (2400 / 19200)  =     1250
  262.  
  263.   The higher the connect speed,  the lower the bytes per minute.
  264.   Only here encase some of wanted it.   However,  if you think
  265.   carefully about it.  A user could fool you easily in such a case
  266.   by connecting at 300 baud.  Swop 10 minutes to receive 800,000 bytes.
  267.   Log-off,  call in at 19200 baud,  and download the 800,000 bytes
  268.   within a few minutes.
  269.  
  270.  
  271. ╔════════════════════════════════╗
  272. ║ LIST OF FILES AND DESCRIPTIONS ║
  273. ╚════════════════════════════════╝
  274.  
  275.     Only two files were issued along with SWOP145K.ZIP
  276.  
  277.     SWOP.DOC    - You are reading it right now.
  278.     SWOP.EXE    - The actual door program.
  279.     FILE_ID.DIZ - BBS file description for this program.
  280.  
  281.  
  282. ╔═════════╗                                                      PAGE 7
  283. ║ HISTORY ║
  284. ╚═════════╝
  285.     01 December 1991  :  "SWOP145A.ZIP"
  286.                          Initial release of the SWOP door.
  287.  
  288.     06 December 1991  :  "SWOP145B.ZIP"  -  Version 1.0
  289.                          Same as for 01 December 1991,  but is called
  290.                          Version 1.0.   With this version we removed
  291.                          all crippling that was in previous release.
  292.  
  293.     10 December 1991  :  "SWOP145C.ZIP"  -  Version 1.01
  294.                          Program was unable to detect that it is the
  295.                          SYSOP on-line,  if the SYSOP has entered his
  296.                          name in PCBSETUP with non-capital letters.
  297.                          This meant that in this case,  the sysop
  298.                          would not be able to change the security
  299.                          configuration from the local console as he
  300.                          is suppose to do.
  301.                          Fixed this by making the program not to be
  302.                          case sensitive when checking for the SYSOP's
  303.                          name.    ooops...
  304.  
  305.     12 December 1991  :  "SWOP145D.ZIP"  -  Version 1.02
  306.                          Somewhere we did something wrong in vers. 1.01
  307.                          The program was suddenly unable to transmit
  308.                          characters over the comms port.
  309.                                    Sorry....    fixed now.
  310.  
  311.     16 December 1991  :  "SWOP145E.ZIP"  -  Version 1.03
  312.                          Still the same old problem that the program is
  313.                          unable to transmit characters over the comms
  314.                          port.  This was because we tried to get clever
  315.                          with software flow-control (XON/XOFF),  and
  316.                          hardware flow-control (CTS/RTS).  We now removed
  317.                          the ability to adapt to the hardware/software
  318.                          flow control.  We now take the comm port as left
  319.                          by PCBoard,  and return it back the way we
  320.                          received it.  Seems like this solved our
  321.                          problem.  Let us know if anyone with an
  322.                          error-correcting modem experience some
  323.                          problems,  although we expect to hear every
  324.                          one is happy with it,  the way it is now.
  325.  
  326.     19 December 1991  :  "SWOP145F.ZIP"  -  Version 1.04
  327.                          The door had a problem that it gets an runtime
  328.                          error,  as soon as it was installed for the first
  329.                          time.  It was because we attempted to delete a
  330.                          file,  that was still open.   This is now fixed,
  331.                          thanks to the thorough investigation of Joaqium
  332.                          Inacio from VC BBS at (011) 435-3922.  Thank
  333.                          you for your patience George.
  334.  
  335.     20 December 1991  :  "SWOP145G.ZIP"  -  Version 1.05
  336.                       1. Removed the [NOT REGISTERED] handicap if not
  337.                          registered.  We now no longer force you to
  338.                          register.  We now ask you politely to register
  339.                          "yourself" as a user,  and not to register
  340.                          the "program".   So,  as from this release the
  341.                          program will allways be as if it is registered
  342.                          allready.
  343.                       2. All previous programs,  registered or not, would
  344.                          only be able to opperate under PCBoard 14.5.
  345.                          As from this release,  it is programmed to
  346.                          allready accept the new formats of PCBoard
  347.                          vers 15.0 and higher.
  348.                       3. Also we done some "fine-tuning",   that resulted
  349.                          into the fact that the program code was decreased
  350.                          with at least 3400 bytes.
  351.  
  352.     19 January 1992  :  "SWOP145H.ZIP"  -  Version 1.06
  353.                       1. We added the Bytes/Minute information on the
  354.                          Main Menu screen.   Seems like the users don't
  355.                          like to read our "fancy" help screen  ..grin..
  356.                       2. Removed the "Returning to BBS ..." notice,
  357.                          after the user is done with the door.  (Default)
  358.                       3. Added a parameter "/S" for incase you want the
  359.                          message "Returning to BBS..." to be displayed
  360.                          to your users when they are done with the door.
  361.                       4. Added a feature to provide information inside
  362.                          the callers log,  of what the user done while
  363.                          he/she used the swop door.
  364.  
  365.        30 June 1992  :  "SWOP145I.ZIP"  -  Version 1.07
  366.                       1. The door forgot to look at a users expiry date.
  367.                          This meant that if a subscribers,  subs period
  368.                          has expired,  the door kept on working on it
  369.                          subscription security level,  instead of the
  370.                          expired security level.   --fixed--
  371.                       2. The door allways gave a user one extra minute
  372.                          if a user entered,  and exited from the door.
  373.                          Problem now solved.
  374.  
  375.        17 July 1992  :  "SWOP145J.ZIP"
  376.                       1. We removed the facility of direct writing to the
  377.                          screen.  We had reports of bleed through on the
  378.                          windows of Desqview.  This will no longer happen,
  379.                          as we now do all screen updates via the BIOS.
  380.                       2. Added the /T parameter.  To allow you to disable
  381.                          swopping time for more bytes.
  382.                       3. Added the /B parameter.  To allow you to disable
  383.                          swopping bytes for more time.
  384.  
  385.   19 September 1992  :  "SWOP145K.ZIP"
  386.                       1. Recieved complains that SWOP is unable to handle
  387.                          the flow control of characters correctly.  Caused
  388.                          that the user on the other side recieves a lot of
  389.                          garbage.   -- FIXED --
  390.  
  391.  
  392. - THE END -
  393.